getStations

Returns the list of stations served by the server you are connected to.

Sample Request

<mmRequest command="getStations" [version="1"] [client=""] [userData=""] />

Request Notes

This command does not reference a specific database on the server, so no station attribute is needed.

Sample Reply PRO

<mmReply command="getStations" version="1" [userData=""] status="ok">
	<contents>
		<stations>
			<station>
				<id>Oldies</id>
				<description>MusicMaster Oldies</description>
				<interface>generic</interface>
				<status>0</status>
			</station>
			<station>
				<id>Sample</id>
				<description>Sample Database</description>
				<interface>generic</interface>
				<status>0</status>
			</station>
		</stations>
	</contents>
</mmReply>

Sample Reply CS

<mmReply command="getStations" version="1" messageId="dd0f536e-ebb5-454b-bcf6-e9420de1cfb7" userData="hello" status="ok">
  <contents>
    <stations>
      <station>
        <id>Enterprise</id>
        <description>MusicMaster CS Enterprise Library</description>
        <interface>generic</interface>
        <status>0</status>
      </station>
      <station backcolor="55295">
        <id>MMCS - AM</id>
        <description>MMCS - AM</description>
        <interface>generic</interface>
        <status>0</status>
      </station>
      <station backcolor="9157775">
        <id>MMCS - FM</id>
        <description>MMCS - FM</description>
        <interface>generic</interface>
        <status>0</status>
      </station>
      <station backcolor="11829830">
        <id>MMCS - HD</id>
        <description>MMCS - HD</description>
        <interface>generic</interface>
        <status>0</status>
      </station>
    </stations>
  </contents>
</mmReply>

Reply Notes

Each station server by the server is returned in a station tag. These are all returned in a stations tag.

• id – returns the unique ID for each station
• description – the MusicMaster database logo
• interface – this value is either ‘generic’ of the name of the custom interface in use
• status – returns a numeric value indicating the status of the station database connection
  • 0=ok
  • 1=busy (temporary condition while the database is being opened and inspected)
  • -1=error (unable to locate or open the specified database)

 

Note: You will use the value of the id tag when calling other database-specific functions.

Compatibility and Version Info

Available in all versions

Documentation of the station status tag updated 10-28-2010